Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat: drop user to last chat after leaving a room #31097

Conversation

eh2077
Copy link
Contributor

@eh2077 eh2077 commented Nov 9, 2023

Details

Fixed Issues

$ #30778
PROPOSAL: #30778 (comment)

Tests

=== Preparation ===

  1. Login App with User B and create 4 rooms, like room-1, room-2, room-3 and room-4
  2. Invite User A to the 4 rooms
  3. Login App with User A

=== Case 1 ===

  1. Open DM with User B
  2. Open room-1
  3. Leave room-1
  4. Verify dropping to DM with User B

=== Case 2 ===

  1. Open DM with User B
  2. Open room-2
  3. Open room-3
  4. Leave #room-3
  5. Verify dropping to #room-2
  6. Leave #room-2
  7. Verify dropping to DM with User B

=== case 3 (Web only) ===

  1. Open DM with User B
  2. Open room-4
  3. Reload the page
  4. Leave room-4
  5. Verify dropping to DM with User B
  • Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

Same as tests

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
0-android.mp4
Android: mWeb Chrome
0-mobile-chrome.mp4
iOS: Native
0-ios.mp4
iOS: mWeb Safari
0-mobile-safari.mp4
MacOS: Chrome / Safari
0-web.mp4
MacOS: Desktop
0-desktop.mp4

@eh2077 eh2077 requested a review from a team as a code owner November 9, 2023 05:44
@melvin-bot melvin-bot bot requested review from getusha and removed request for a team November 9, 2023 05:44
Copy link

melvin-bot bot commented Nov 9, 2023

@getusha Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@eh2077
Copy link
Contributor Author

eh2077 commented Nov 9, 2023

In small screen, if we want to just return to the home page, we can let method leaveRoom accept parameter isSmallScreenWidth (which can be derived from withWindowDimensions) and navigate to home page if isSmallScreenWidth is true. This can be a possible follow up.

src/libs/actions/Report.js Outdated Show resolved Hide resolved
src/libs/actions/Report.js Outdated Show resolved Hide resolved
src/CONST.ts Outdated Show resolved Hide resolved
@eh2077 eh2077 requested a review from getusha November 10, 2023 03:40
@getusha
Copy link
Contributor

getusha commented Nov 10, 2023

Thanks for the updates @eh2077, the Perf. tests are failing i wonder why, can you check?

@eh2077
Copy link
Contributor Author

eh2077 commented Nov 10, 2023

@getusha I think the Pef. tests just fail occasionally. The previous PR #31094 has same issue.

src/libs/actions/Report.js Outdated Show resolved Hide resolved
@getusha
Copy link
Contributor

getusha commented Nov 10, 2023

I noticed this strange behavior.

Screen.Recording.2023-11-10.at.12.20.46.PM.online-video-cutter.com.mp4

@eh2077
Copy link
Contributor Author

eh2077 commented Nov 10, 2023

@getusha Interesting finding. I think it's because we broadcast event when leaving a room, see

broadcastUserIsLeavingRoom(reportID);

and navigate to concierge page here
Report.navigateToConciergeChat();

Not sure if we should try to drop to last chat in this case?

cc @techievivek

src/libs/actions/Report.js Outdated Show resolved Hide resolved
@techievivek
Copy link
Contributor

@eh2077

Coming from your comment here: #31097 (comment), I agree that we should have the logic here as well that will try to drop the user to the previous chat they were on.

@getusha
Copy link
Contributor

getusha commented Nov 13, 2023

@eh2077 i think yes we should put them on HOLD. could you tell me how 1st and 2nd relate to this?

@eh2077
Copy link
Contributor Author

eh2077 commented Nov 13, 2023

@eh2077 i think yes we should put them on HOLD. could you tell me how 1st and 2nd relate to this?

Based on @techievivek 's #31097 (comment), I agree the 1st and 2nd are not related this change.

@techievivek
Copy link
Contributor

@eh2077 QQ: How is the 4th issue related to the changes we are making here?

@eh2077
Copy link
Contributor Author

eh2077 commented Nov 13, 2023

@techievivek Because I'm going to change this line

Report.navigateToConciergeChat();

to

            const lastAccessedReportID = Report.updateRecentlyAccessedReportID('');
            if (lastAccessedReportID) {
                Navigation.navigate(ROUTES.REPORT_WITH_ID.getRoute(lastAccessedReportID));
            } else {
                Report.navigateToConciergeChat();
            }

which will change the bug report effect of that issue.

@getusha
Copy link
Contributor

getusha commented Nov 13, 2023

Commented on the issue, @eh2077 is this ready to be tested again?

@eh2077
Copy link
Contributor Author

eh2077 commented Nov 13, 2023

@getusha Thanks. Yeah, I just push new changes. With the new changes, below is the demo for this case #31097 (comment)

0-multi-tab-leave-room.mp4

Note: After leaving room, the LHN won't be updated automatically. We need to revisit the room to let the left room disappear from LHN. Same behaviour in production.

@eh2077
Copy link
Contributor Author

eh2077 commented Nov 15, 2023

@getusha This is ready for review again, see the comment above ^

* @returns {String} Returns the most recent accessed reportID
*/
function getMostRecentlyAccessedReportID() {
return recentlyAccessedReportIDs.length > 0 ? recentlyAccessedReportIDs[recentlyAccessedReportIDs.length - 1] : '';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be more cleaner if we return all report ids and use the last one on the place where we want to use it.

updateRecentlyAccessedReportID(reportID, true);
const recentlyAccessedReportIDs = getMostRecentlyAccessedReportIDs();
const recentlyAccessedReportID = _.last(recentlyAccessedReportIDs);

and use it like that instead of returning a value from updateRecentlyAccessedReportID, what do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I'd prefer not returning the reportID list because we don't want the reportID array to be potentially modified by client.

and use it like that instead of returning a value from updateRecentlyAccessedReportID, what do you think?

I think let method updateRecentlyAccessedReportID update the stack and return most recently accessed reportID is clean like the use case in method leaveRoom

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer not returning the reportID list because we don't want the reportID array to be potentially modified by client.

I am not sure i understood this, could you explain it further?

This kind of feels wrong to me returning the same thing from two functions making it duplicate and very limited, i think this will be more cleaner. what do you think @techievivek

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I think the current two methods are clean enough. See below 3 use cases

  1. In method leaveRoom, we make a single method call
const lastAccessedReportID = updateRecentlyAccessedReportID(reportID, true);

to remove the reportID from stack and return the most recently accessed reportID.
2. In the event listener, we call

Report.updateRecentlyAccessedReportID(reportID);

to update the reportID in the stack and omit the return value.
3. In ReportScreen, we don't need to update reportID in the stack. So we just call method

const lastAccessedReportID = Report.getMostRecentlyAccessedReportID();

to read the most recently accessed reportID.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still, it doesn't make sense to me to have two separate functions returning the same value, and i don'
t expect to have a value to be returned from updateRecentlyAccessedReportID.

  1. Update the recently accessed report id stack and get the value
updateRecentlyAccessedReportID(reportID, true);
const recentlyAccessedReportIDs = getMostRecentlyAccessedReportIDs();
const recentlyAccessedReportID = _.last(recentlyAccessedReportIDs);
  1. Get recently accessed report id without updating the value
const recentlyAccessedReportIDs = getMostRecentlyAccessedReportIDs();
const recentlyAccessedReportID = _.last(recentlyAccessedReportIDs);

I'll let @techievivek weigh #31097 (comment)

Copy link
Contributor Author

@eh2077 eh2077 Nov 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I got your point. I'm also fine to

  1. let method updateRecentlyAccessedReportID not return value
  2. let method getMostRecentlyAccessedReportID to return the most recently accessed reportID. I think it makes more sense the hide the logic to extract the reportID inside the method.

What do you think?

@getusha
Copy link
Contributor

getusha commented Nov 15, 2023

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified tests pass on all platforms & I tested again on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
Screen.Recording.2024-01-18.at.3.05.24.PM.mov
Android: mWeb Chrome
Screen.Recording.2024-01-16.at.6.47.46.PM.mov
iOS: Native
Screen.Recording.2024-01-16.at.7.03.06.PM.mov
iOS: mWeb Safari
Screen.Recording.2024-01-16.at.6.55.57.PM.mov
MacOS: Chrome / Safari

Case 1

Screen.Recording.2024-01-16.at.5.33.19.PM.mov

Case 2

Screen.Recording.2024-01-16.at.5.36.33.PM.mov

Case 3

Screen.Recording.2024-01-16.at.5.38.30.PM.mov
MacOS: Desktop
Screen.Recording.2024-01-18.at.3.13.29.PM.mov

@techievivek
Copy link
Contributor

@eh2077 Hey Eric, sorry for the trouble here but it looks like we have agreed on a different solution that utilizes a new key on the reports object (lastVisitedTime), which will be implemented as part of this GH: #30868, and it seems like we will need to HOLD this PR for a bit.

@eh2077
Copy link
Contributor Author

eh2077 commented Jan 18, 2024

@getusha Updated to skip empty chats. Kindly have another look, thanks!

src/libs/actions/Report.ts Outdated Show resolved Hide resolved
@eh2077 eh2077 requested a review from getusha January 18, 2024 12:19
@eh2077
Copy link
Contributor Author

eh2077 commented Jan 18, 2024

@getusha CI passed and please have another look.

Copy link
Contributor

@getusha getusha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, all cases work well. @techievivek all yours!

@eh2077
Copy link
Contributor Author

eh2077 commented Jan 23, 2024

@techievivek Gentle bump!

src/libs/actions/Report.ts Show resolved Hide resolved
src/libs/actions/Report.ts Outdated Show resolved Hide resolved
@eh2077 eh2077 force-pushed the feat-30778-drop-user-to-last-chat-after-leaving-room branch from 65c759c to 756876a Compare January 24, 2024 14:25
@eh2077
Copy link
Contributor Author

eh2077 commented Jan 24, 2024

Solved conflicts from TS migration and re-tested all use cases.


// We want to filter out the current report, hidden reports and empty chats
const filteredReportsByLastRead = sortedReportsByLastRead.filter(
(report) =>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wouldn't this be easier if we just rename this to sortedReport instead of renaming the above report variable?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 I agree

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, yes sortedReport is definitely better!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a comment about the rename. Also, let's avoid force pushing code as that makes reviews harder and get rid of commit history.


// We want to filter out the current report, hidden reports and empty chats
const filteredReportsByLastRead = sortedReportsByLastRead.filter(
(report) =>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 I agree

@luacmartins
Copy link
Contributor

@getusha all yours

Copy link
Contributor

@getusha getusha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@luacmartins luacmartins merged commit e485d9c into Expensify:main Jan 26, 2024
18 checks passed
@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.33-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 cancelled 🔪
🕸 web 🕸 success ✅

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.33-5 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 web 🕸 success ✅

policies: {},
excludeEmptyChats: true,
doesReportHaveViolations: false,
}),
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We missed to consider Selfdm here, which led to this bug

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was merged before we introduced selfDMs 😄 So I would say we should have handled this in the design doc rather.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants